home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / wildcat / qwkhold1.zip / QWK2HOLD.DOC < prev    next >
Text File  |  1996-05-17  |  11KB  |  273 lines
  1. QWKHOLD1.ZIP by James Mardis @ Fidonet 1:322/746    5/11/96
  2.  
  3.  
  4.  
  5.  
  6. This package of programs were written to allow callers the ability to
  7. turn ON/OFF the automatic making of QWK mail packets.
  8.  
  9.  
  10. If you read nothing else, be sure and modify the QWK2HOLD.CFG before
  11. you try and run this set of programs.  I'd suggest reading all of the
  12. QWK2HOLD.DOC (this) file at least once before you try to use the program.
  13.  
  14.  
  15. All of these programs are compiled using WcCode 4.12.  The source code
  16. uses programming commands that did not exist in earlier versions.
  17. The source code is included with this package so you can make changes
  18. or even try to re-write the code to work for an older version of WcCode
  19. if you so wish.
  20.  
  21.  
  22.  
  23. REGISTRATION: There is none.  I would not mind a note from you indicating
  24.               that you are using the program but the note is entirely
  25.               at your own discression.
  26.  
  27.  
  28.  
  29. LOGON2.WCX is the program that will notify callers they have new QWK mail
  30. and let them download it.  It can also be renamed LOGON1.WCX with out
  31. having to recompile it but my personal preference is to have it in the
  32. number two position myself.
  33.  
  34.  
  35.  
  36. QWK2HOLD.WCX is used to allow callers to turn on/off the making of QWK mail
  37. packets.  I added it to my system as letter "A" in my mail menu using the
  38. word A)utomate QWK.  It does not take much prompting for people to find
  39. out it will save them much online time.  It will use one of the User
  40. COMMENT( ) fields in the caller's record.  The QWK.CFG determines which
  41. COMMENT field is used.  Please make sure you pick a Comment(?) value that
  42. is not in use by some other program.
  43.  
  44. An optional file called QWK2HOLD.TXT can be created by the Sysop if you
  45. do not want to use the default text the callers will read when they
  46. ask for more information.  If QWK2HOLD.TEXT is found it will be used in
  47. place of the the encoded text.
  48.  
  49.  
  50.  
  51. QWK2MAKE.WCX is to be run as an part of a batch program.  It requires
  52. that the environment variable WCPORTID be set to 0 (zero) in order to
  53. function correctly.
  54.  
  55.  
  56.  
  57. QWK2WAIT.BAT is a batch program that QWK2MAKE.WCX will create if a
  58. caller is still online when the program attempts to make that user's
  59. mail packets.  You can use it in a Wildcat! "event", some periodic
  60. BATCH program you run, or ignore it.  If it still exists when QWK2MAKE
  61. is run again it will be deleted or a new one created if the need still
  62. exists.  Its purpose is to give you one last chance to make mail packets
  63. for those callers who stayed online during processing.
  64.  
  65.  
  66.  
  67. QWK2HOLD.CFG is the configuration file that you MUST modify before the
  68. programs will work properly for you.
  69.  
  70. An example of the configuration file is shown below along with the
  71. descriptions of what the lines are used for and need to contain.
  72.  
  73. C:\MAIL\
  74. 8
  75. C:\WILDCAT\QWK\
  76. COMMENT(5)
  77. NEWUSER
  78. NO SEC2
  79. 26
  80. 20
  81. 3615200
  82. 0
  83. 0E
  84. 0F
  85. 0B
  86. 0C
  87. C:\WILDCAT\FLAGS\
  88. FidoNet mail is being processed at this time.
  89. WildNet mail is being processed at this time.
  90. SAF-Net mail is being processed at this time.
  91. Mail run #4 is being processed at this time.
  92. Slow road ahead, Mail processing is in progress.
  93.  
  94.  
  95. All entries in the .CFG file after line #20 are ignored and could be deleted.
  96.  
  97. The configuration file, QWK2HOLD.CFG breaks down as follows:
  98. Line #1, Complete PathName where WCMAIL QWK stores mail packets,
  99.          such as C:\WILDCAT\MAIL\QWK\.
  100.          NOTE: Line #1 and Line #3 must not be the same value.
  101.  
  102. Line #2, File area number for QWK Mail that was chosen in the Makewild
  103.          QWK Mail area.  Your callers should not have access to this
  104.          download area.
  105.  
  106. Line #3, Complete PathName where QWK2 can store all user mail packets.
  107.          NOTE: Line #1 and Line #3 must not be the same value.
  108.  
  109.          NOTE: This area is not to be part of or created by Makewild.
  110.                This subdirectory should not be in use by any other program.
  111.  
  112. Line #4, Valid values are COMMENT(1) through COMMENT(5) exactly as shown.
  113.          The right and left parentheses around the number are mandatory.
  114.          The actual value found in the user's COMMENT(?) field will
  115.          contain either QWK2 ON, QWK2 OFF or be blank.  Make sure the
  116.          COMMENT(?) value you pick for this program is not in use by
  117.          any other program.
  118.  
  119. Line #5, Security Profile #1 to exclude from operating this program.
  120.          I use this to bar NEWUSER from this program
  121.          while allowing them access to other WCX programs.
  122.          If not used set it to NO SEC1.
  123.  
  124. Line #6, Security Profile #2 to exclude from operating this program.
  125.          If not used set it at NO SEC2.
  126.  
  127. Line #7  Maximum number of QWK packets a caller can have waiting for pickup.
  128.          Valid values are 1 to 26.
  129.  
  130. Line #8  Maximum number of days to keep stored QWK packets.
  131.          Valid values are 1 to 365.
  132.  
  133. Line #9  Maximum allowed storage space for user packets in bytes, but
  134.          a minimum of 1 packet is allowed regardless of this value.
  135.          Valid values are 1 to 2147483, this is in Kbytes.
  136.  
  137. Line #10 Conference number where user messages are to be sent.
  138.          Messages will be sent with the Private flag turned on.
  139.  
  140. Line #11 Prompt colors normal for Text and Background, leave off @ symbols.
  141.          Default two character code is 0E.
  142.  
  143. Line #12 Prompt colors normal for Highlighted Text.
  144.          Default two character code is 0B.
  145.  
  146. Line #13 Prompt colors normal for Packet size and elsewhere.
  147.          Default two character code is 0C.
  148.  
  149. Line #14 Prompt colors normal for warning messages.
  150.          Default two character code is 0E.
  151.  
  152. Line #15 Path to inbound mail flag,  Path to where QWK2MA?.FLG's.
  153.          This line is just the path to the directory where the flags
  154.          in lines 16 through 20 are to be created in, if used.  It
  155.          is up to you to modify your batch program(s) to actually
  156.          create the flag(s) you want activated.
  157.  
  158. Line #16 Text to display when Mail Flag #1 (QWK2MA1.FLG) is found.
  159.  
  160. Line #17 Text to display when Mail Flag #2 (QWK2MA2.FLG) is found.
  161.  
  162. Line #18 Text to display when Mail Flag #3 (QWK2MA3.FLG) is found.
  163.  
  164. Line #19 Text to display when Mail Flag #4 (QWK2MA4.FLG) is found.
  165.  
  166. Line #20 Text to display when Mail Flag #5 (QWK2MA5.FLG) is found.
  167.  
  168.  
  169.  
  170. A short four line BATCH file "example" is shown below which will give you
  171. an example of how you would change your existing mail BATCH program so
  172. that mail packets are made after your mail has been processed.
  173.  
  174.        ECHO Turn on Mail Processing Flag #3 > C:\WILDCAT\FLAGS\QWK2MA3.FLG
  175.        CD\WILDCAT
  176.        SET WCPORTID=0
  177.        WILDCAT /R QWK2MAKE.WCX
  178.  
  179. The batch example can be added to your existing mail processing batch.
  180. The QWK2MA1.FLG file being made can be used to alert callers that not
  181. all mail has finished being processed yet.  You need to provide the same
  182. path information to the QWK2MA3.FLG as you have put in line #15 of the
  183. QWK2HOLD.CFG file.  Most people put this flag line at the beginning of
  184. their mail BATCH program.  The flag file, if used, will be deleted by
  185. QWK2MAKE.WCX when it is finished.
  186.  
  187.  
  188.  
  189. QWK2 FLAGS
  190. The creation of the mail flag(s) used in LOGON2.WCX and QWK2HOLD.WCX
  191. is left up to the Sysop.  He or she needs to include a line(s) of text in
  192. the BATCH program used to run the QWK2MAKE program to create the flag(s).
  193. You do this by adding a line such as shown below:
  194.  
  195. ECHO Turn on Flag #3 > (path)\QWK2MA3.FLG
  196. You need to replace the (path) with the path used in the configuration
  197. line #15 for this to work right.
  198.  
  199.  
  200.  
  201. MAKEWILD LOCAL QWK Mailer Limits
  202. A couple of items that will assist you in managing things here.  You will
  203. need to go into MakeWild and set the LOCAL QWK mailer limits to what
  204. ever size mail packets you want to allow callers to create.  These will be
  205. the maximum values, not necessarily what the individual callers choose to
  206. use.  They may set their values lower if they so choose.
  207.  
  208.  
  209.  
  210. DOS PATH Statement
  211. Your WILDCAT home directory needs to be included in the path statement
  212. for the DOS session you are operating this set of programs in.
  213. You can check for this by going to dos and then typing the command
  214.  
  215. SET  (and ending it with a carriage return)
  216.  
  217. This will show you any or all environment variables you have active with
  218. one of them starting with PATH=.  It is in this PATH= string that you must
  219. find your Wildcat home directory.  If it is missing you will need to
  220. add it to the PATH.  One way is to copy down the existing PATH as it is and
  221. at the beginning of the batch program which starts your Wildcat session add
  222. SET PATH=(and retype what was found when you ran the SET command), at the
  223. semicoln ";" (add one if the PATH line does not end with one) and the PATH
  224. for your Wildcat home directory.
  225.  
  226. An example is SET PATH=(origional path);/WILDCAT
  227. You may end the path with a semicoln or not as DOS does not care which
  228. way it ends.
  229.  
  230.  
  231.  
  232. COLORS
  233. The color code chart showing the code combinations is shown below.
  234. Hex Value   Screen Color   Background   Forground
  235.    0          Black         Normal       Normal
  236.    1          Blue          Normal       Normal
  237.    2          Green         Normal       Normal
  238.    3          Cyan          Normal       Normal
  239.    4          Red           Normal       Normal
  240.    5          Magenta       Normal       Normal
  241.    6          Brown         Normal       Normal
  242.    7          White         Normal       Normal
  243.    8          Black         Blinks FG    Hi Intensity
  244.    9          Blue          Blinks FG    Hi Intensity
  245.    A          Green         Blinks FG    Hi Intensity
  246.    B          Cyan          Blinks FG    Hi Intensity
  247.    C          Red           Blinks FG    Hi Intensity
  248.    D          Magenta       Blinks FG    Hi Intensity
  249.    E          Brown         Blinks FG    Hi Intensity
  250.    F          White         Blinks FG    Hi Intensity
  251.  
  252. This means a code of 04 would be a black background and Red letters.
  253. 0C would be black background with Bright Red letters.
  254. 8C would be black background with flashing Bright Red letters, OR so
  255. the WcCode manual says.  I let you try the color code combinations
  256. on your own as they are dependent on the monitors used.
  257.  
  258.  
  259.  
  260. OLDER VERSIONS
  261. These programs were released in an earlier version under the name of
  262. QWK2PACK.ZIP.  Any copies of the earlier versions should be deleted when
  263. found.  If you are upgrading you should delete all of the older programs
  264. as they are not compatible with the new versions.
  265.  
  266.  
  267.  
  268. WARRANTY
  269. These programs carry no Warranty or Guarantee whatsoever.  You use these
  270. programs at your own risk.  The original Author shall NOT be held
  271. responsible for any damages whatsoever as to the result or use of these
  272. programs.
  273.